Skip to content

docs: user guide#36

Merged
KeranYang merged 6 commits intonumaproj-contrib:mainfrom
jacque1ine:docs/user-guide
Apr 9, 2025
Merged

docs: user guide#36
KeranYang merged 6 commits intonumaproj-contrib:mainfrom
jacque1ine:docs/user-guide

Conversation

@jacque1ine
Copy link
Collaborator

@jacque1ine jacque1ine commented Apr 7, 2025

No description provided.

@KeranYang
Copy link
Contributor

KeranYang commented Apr 8, 2025

Thank you @jacque1ine for writing detailed user guide. Just a few high level suggestions - 1. we now have two user guides, one is the README.md and this one. Let's keep using README.md as the guide and change this one to something like running pulsar on StreamNative. 2. we already have two folders, one for source and one for sink. User should always go to one of them for creating a pipeline. I see that in both files, we have a section to Have a Pulsar cluster running, can we have change this PR to setup StreamNative on the Have a Pulsar cluster running section, and then update the following steps to add auth? Basically merge user guide to source and sink guides.

jacque1ine and others added 4 commits April 8, 2025 14:16
@jacque1ine
user guide
585ba48 
Signed-off-by: jacque1ine <js3fung@uwaterloo.ca>
@jacque1ine @KeranYang
docs: updated docs to work with jwt token auth (numaproj-contrib#33)
82a1b81 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Keran Yang <yangkr920208@gmail.com>
Signed-off-by: jacque1ine <js3fung@uwaterloo.ca>
@jacque1ine
address PR comments
901c207 
Signed-off-by: jacque1ine <js3fung@uwaterloo.ca>
@jacque1ine
rename token to api key
fe3ae0b 
Signed-off-by: jacque1ine <js3fung@uwaterloo.ca>
@jacque1ine jacque1ine requested a review from Copilot April 8, 2025 18:43
Copilot AI reviewed Apr 8, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

docs/source/byte-array/manifests/api-key/byte-arr-consumer-pipeline.yaml:4

  • The pipeline is defined in a consumer context but is named 'raw-producer-pipeline'. Consider renaming it to 'raw-consumer-pipeline' (or similar) to accurately reflect its purpose.
  name: raw-producer-pipeline

@KeranYang KeranYang merged commit 4cbaa28 into numaproj-contrib:main Apr 9, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@KeranYang KeranYang KeranYang approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jacque1ine @KeranYang

Comments